<!doctype html>
<html lang="en-US">
<head>
	<meta charset="UTF-8" />
	<title>Congo Documentation</title>
	<link rel="stylesheet" type="text/css" href="pagestyle.css" />
</head>
<body>
	<div class="sheet container">
		<header class="main">

			<div class="title">
				<a href="Modules_congo.html"><img src="data/congo.png"/></a>Congo Documentation
			</div>

		</header>

		<div class="row content">
			<div class="span12">
			
				
<h1>Class <span class="name">ScrollLayer</span></h1>


	<p>A layer with drag, swipe, inertia and bounce effects.
	<a href="#description"> More...</a></p>


<hr>

<table class="table scope-contents">
	
		<tr>
			<td class="span1 name">Extends:</td>
			<td>
				<ul class="unstyled">
					<li><a href="Modules_congo.layer_Layer.html">Layer</a></li>
				</ul>
			</td>
		</tr>
	
	
	
	
	

	

	
	
	
	
	

	

								
		<tr>
			<td class="span1 name">Fields:</td>
			<td>
				<ul class="unstyled">
					
						<li><a href='#botLimit'>botLimit</a> : Float</li>
					
						<li><a href='#bounce'>bounce</a> : Bool</li>
					
						<li><a href='#dragStartPos'>dragStartPos</a> : Point</li>
					
						<li><a href='#inertia'>inertia</a> : Float</li>
					
						<li><a href='#leftLimit'>leftLimit</a> : Float</li>
					
						<li><a href='#maxSpeed'>maxSpeed</a> : Float</li>
					
						<li><a href='#rightLimit'>rightLimit</a> : Float</li>
					
						<li><a href='#snapDist'>snapDist</a> : Float</li>
					
						<li><a href='#snapPoints'>snapPoints</a> : List&lt;Point&gt;</li>
					
						<li><a href='#topLimit'>topLimit</a> : Float</li>
					
						<li><a href='#velocity'>velocity</a> : Point</li>
					
						<li><a href='#xlocked'>xlocked</a> : Bool</li>
					
						<li><a href='#ylocked'>ylocked</a> : Bool</li>
					
				</ul>
			</td>
		</tr>
	
	
								
		<tr>
			<td class="span1 name">Constructors:</td>
			<td>
				<ul class="unstyled">
					
						<li><a href='#New'>New</a> ( w:Int, h:Int )</li>
					
				</ul>
			</td>
		</tr>
	
	
	
	
								
		<tr>
			<td class="span1 name">Methods:</td>
			<td>
				<ul class="unstyled">
					
						<li><a href='Modules_congo.scrolllayer_ScrollLayer.html#AddSnapPoint'>AddSnapPoint</a> : Void ( pt:Point )</li>
					
						<li><a href='Modules_congo.scrolllayer_ScrollLayer.html#Update'>Update</a> : Void ( dT:Int )</li>
					
				</ul>
			</td>
		</tr>
	

	
	
								
		<tr>
			<td class="span1 name">Inherited Properties:</td>
			<td>
				<ul class="unstyled">
					
						<li><a href='Modules_congo.displayitem_DisplayItem.html#Actions'>Actions</a> : List&lt;Action&gt; ()</li>
					
						<li><a href='Modules_congo.displayitem_DisplayItem.html#Angle'>Angle</a> : Float ()</li>
					
						<li><a href='Modules_congo.displayitem_DisplayItem.html#Angle(2)'>Angle</a> : Void ( rot:Float )</li>
					
						<li><a href='Modules_congo.displayitem_DisplayItem.html#Children'>Children</a> : DisplayItem[] ()</li>
					
						<li><a href='Modules_congo.displayitem_DisplayItem.html#CustomFlag'>CustomFlag</a> : Bool ()</li>
					
						<li><a href='Modules_congo.displayitem_DisplayItem.html#CustomFlag(2)'>CustomFlag</a> : Void ( state:Bool )</li>
					
						<li><a href='Modules_congo.displayitem_DisplayItem.html#CustomId'>CustomId</a> : Int ()</li>
					
						<li><a href='Modules_congo.displayitem_DisplayItem.html#CustomId(2)'>CustomId</a> : Void ( value:Int )</li>
					
						<li><a href='Modules_congo.displayitem_DisplayItem.html#CustomItemRef'>CustomItemRef</a> : DisplayItem ()</li>
					
						<li><a href='Modules_congo.displayitem_DisplayItem.html#CustomItemRef(2)'>CustomItemRef</a> : Void ( item:DisplayItem )</li>
					
						<li><a href='Modules_congo.displayitem_DisplayItem.html#CustomName'>CustomName</a> : String ()</li>
					
						<li><a href='Modules_congo.displayitem_DisplayItem.html#CustomName(2)'>CustomName</a> : Void ( name:String )</li>
					
						<li><a href='Modules_congo.displayitem_DisplayItem.html#DirtyZOrder'>DirtyZOrder</a> : Bool ()</li>
					
						<li><a href='Modules_congo.displayitem_DisplayItem.html#Handle'>Handle</a> : Point ()</li>
					
						<li><a href='Modules_congo.displayitem_DisplayItem.html#Hidden'>Hidden</a> : Bool ()</li>
					
						<li><a href='Modules_congo.displayitem_DisplayItem.html#Hidden(2)'>Hidden</a> : Void ( state:Bool )</li>
					
						<li><a href='Modules_congo.layer_Layer.html#LayerHeight'>LayerHeight</a> : Int ()</li>
					
						<li><a href='Modules_congo.layer_Layer.html#LayerWidth'>LayerWidth</a> : Int ()</li>
					
						<li><a href='Modules_congo.displayitem_DisplayItem.html#NumChildren'>NumChildren</a> : Int ()</li>
					
						<li><a href='Modules_congo.displayitem_DisplayItem.html#Opacity'>Opacity</a> : Float ()</li>
					
						<li><a href='Modules_congo.displayitem_DisplayItem.html#Parent'>Parent</a> : DisplayItem ()</li>
					
						<li><a href='Modules_congo.displayitem_DisplayItem.html#Position'>Position</a> : Void ( pos:Point )</li>
					
						<li><a href='Modules_congo.displayitem_DisplayItem.html#Position(2)'>Position</a> : Point ()</li>
					
						<li><a href='Modules_congo.displayitem_DisplayItem.html#ResScaler'>ResScaler</a> : Float ()</li>
					
						<li><a href='Modules_congo.displayitem_DisplayItem.html#ResScaler(2)'>ResScaler</a> : Void ( rscale:Float )</li>
					
						<li><a href='Modules_congo.displayitem_DisplayItem.html#SetAngle'>SetAngle</a> : Void ( rot:Float )</li>
					
						<li><a href='Modules_congo.displayitem_DisplayItem.html#UseLazySort'>UseLazySort</a> : Bool ()</li>
					
						<li><a href='Modules_congo.displayitem_DisplayItem.html#XScale'>XScale</a> : Float ()</li>
					
						<li><a href='Modules_congo.displayitem_DisplayItem.html#XScale(2)'>XScale</a> : Void ( scale:Float )</li>
					
						<li><a href='Modules_congo.displayitem_DisplayItem.html#YScale'>YScale</a> : Float ()</li>
					
						<li><a href='Modules_congo.displayitem_DisplayItem.html#YScale(2)'>YScale</a> : Void ( scale:Float )</li>
					
						<li><a href='Modules_congo.displayitem_DisplayItem.html#ZOrder'>ZOrder</a> : Float ()</li>
					
				</ul>
			</td>
		</tr>
	
	
								
		<tr>
			<td class="span1 name">Inherited Methods:</td>
			<td>
				<ul class="unstyled">
					
						<li><a href='Modules_congo.displayitem_DisplayItem.html#ActionCompleted'>ActionCompleted</a> : Void ( actionId:Int )</li>
					
						<li><a href='Modules_congo.displayitem_DisplayItem.html#AddChild'>AddChild</a> : Void ( child:DisplayItem )</li>
					
						<li><a href='Modules_congo.displayitem_DisplayItem.html#AddChildWithZOrder'>AddChildWithZOrder</a> : Void ( child:DisplayItem, zOrder:Float=0.0 )</li>
					
						<li><a href='Modules_congo.displayitem_DisplayItem.html#ButtonActivated'>ButtonActivated</a> : Void ( button:Sprite )</li>
					
						<li><a href='Modules_congo.layer_Layer.html#Draw'>Draw</a> : Void ()</li>
					
						<li><a href='Modules_congo.displayitem_DisplayItem.html#FullSortZOrder'>FullSortZOrder</a> : Void ()</li>
					
						<li><a href='Modules_congo.displayitem_DisplayItem.html#GetChildByCustomName'>GetChildByCustomName</a> : DisplayItem ( customName:String )</li>
					
						<li><a href='Modules_congo.displayitem_DisplayItem.html#HasChild'>HasChild</a> : Bool ( ditem:DisplayItem )</li>
					
						<li><a href='Modules_congo.displayitem_DisplayItem.html#PaintItem'>PaintItem</a> : Void ()</li>
					
						<li><a href='Modules_congo.displayitem_DisplayItem.html#RecursiveChildList'>RecursiveChildList</a> : List&lt;DisplayItem&gt; ()</li>
					
						<li><a href='Modules_congo.displayitem_DisplayItem.html#RemoveAllActions'>RemoveAllActions</a> : Void ()</li>
					
						<li><a href='Modules_congo.displayitem_DisplayItem.html#RemoveAllChildren'>RemoveAllChildren</a> : Void ()</li>
					
						<li><a href='Modules_congo.displayitem_DisplayItem.html#RemoveChild'>RemoveChild</a> : Void ( child:DisplayItem )</li>
					
						<li><a href='Modules_congo.displayitem_DisplayItem.html#ReorderChild'>ReorderChild</a> : Void ( child:DisplayItem, z:Float )</li>
					
						<li><a href='Modules_congo.displayitem_DisplayItem.html#RunAction'>RunAction</a> : Void ( action:Action )</li>
					
						<li><a href='Modules_congo.displayitem_DisplayItem.html#SendChildToBack'>SendChildToBack</a> : Void ( child:DisplayItem )</li>
					
						<li><a href='Modules_congo.displayitem_DisplayItem.html#SendChildToFront'>SendChildToFront</a> : Void ( child:DisplayItem )</li>
					
						<li><a href='Modules_congo.displayitem_DisplayItem.html#SetHandle'>SetHandle</a> : Void ( xpos:Float, ypos:Float, adjustForResScale:Bool=false )</li>
					
						<li><a href='Modules_congo.displayitem_DisplayItem.html#SetHidden'>SetHidden</a> : Void ( state:Bool=true )</li>
					
						<li><a href='Modules_congo.displayitem_DisplayItem.html#SetOpacity'>SetOpacity</a> : Void ( alphaLevel:Float, andChildren:Bool=true )</li>
					
						<li><a href='Modules_congo.displayitem_DisplayItem.html#SetPosition'>SetPosition</a> : Void ( pos:Point )</li>
					
						<li><a href='Modules_congo.displayitem_DisplayItem.html#SetPosition(2)'>SetPosition</a> : Void ( xpos:Float, ypos:Float )</li>
					
						<li><a href='Modules_congo.displayitem_DisplayItem.html#SetScale'>SetScale</a> : Void ( scale:Float )</li>
					
						<li><a href='Modules_congo.displayitem_DisplayItem.html#SetScale(2)'>SetScale</a> : Void ( xscl:Float, yscl:Float )</li>
					
						<li><a href='Modules_congo.displayitem_DisplayItem.html#UpdateChildren'>UpdateChildren</a> : Void ( dT:Int )</li>
					
				</ul>
			</td>
		</tr>
	
	
									
		<tr>
			<td class="span1 name">Inherited Functions:</td>
			<td>
				<ul class="unstyled">
					
						<li><a href='Modules_congo.layer_Layer.html#SpriteRectContainsPoint'>SpriteRectContainsPoint</a> : Bool ( spr:Sprite, point:Point )</li>
					
						<li><a href='Modules_congo.layer_Layer.html#SpriteRectsIntersect'>SpriteRectsIntersect</a> : Bool ( spr1:Sprite, spr2:Sprite )</li>
					
				</ul>
			</td>
		</tr>
	
	
</table>


	<a name="description"></a>
	<h2>Detailed Discussion</h2>
	A layer with drag, swipe, inertia and bounce effects. 
Supports vertical or horizontal scrolling, and snapping to 'page' positions.
<p>
** CLASS UNDER DEVELOPMENT ** Needs more features, testing, tidy-up properties etc.
	
	
	<hr>



	<h2>Field Documentation</h2>
	<div class="scope-members-list">
		
			<div class="item">
				<a name='botLimit'></a>
				<div class="well well-small name"><b>Field botLimit : Float</b></div>
				<div class="description">
					<p></p>
					
					
				</div>
			</div>
		
			<div class="item">
				<a name='bounce'></a>
				<div class="well well-small name"><b>Field bounce : Bool</b></div>
				<div class="description">
					<p></p>
					
					
				</div>
			</div>
		
			<div class="item">
				<a name='dragStartPos'></a>
				<div class="well well-small name"><b>Field dragStartPos : <a href="Modules_congo.point_Point.html">Point</a></b></div>
				<div class="description">
					<p></p>
					
					
				</div>
			</div>
		
			<div class="item">
				<a name='inertia'></a>
				<div class="well well-small name"><b>Field inertia : Float</b></div>
				<div class="description">
					<p></p>
					
					
				</div>
			</div>
		
			<div class="item">
				<a name='leftLimit'></a>
				<div class="well well-small name"><b>Field leftLimit : Float</b></div>
				<div class="description">
					<p></p>
					
					
				</div>
			</div>
		
			<div class="item">
				<a name='maxSpeed'></a>
				<div class="well well-small name"><b>Field maxSpeed : Float</b></div>
				<div class="description">
					<p></p>
					
					
				</div>
			</div>
		
			<div class="item">
				<a name='rightLimit'></a>
				<div class="well well-small name"><b>Field rightLimit : Float</b></div>
				<div class="description">
					<p></p>
					
					
				</div>
			</div>
		
			<div class="item">
				<a name='snapDist'></a>
				<div class="well well-small name"><b>Field snapDist : Float</b></div>
				<div class="description">
					<p></p>
					
					
				</div>
			</div>
		
			<div class="item">
				<a name='snapPoints'></a>
				<div class="well well-small name"><b>Field snapPoints : <a href="Modules_monkey.list_List.html">List</a>&lt;<a href="Modules_congo.point_Point.html">Point</a>&gt;</b></div>
				<div class="description">
					<p></p>
					
					
				</div>
			</div>
		
			<div class="item">
				<a name='topLimit'></a>
				<div class="well well-small name"><b>Field topLimit : Float</b></div>
				<div class="description">
					<p></p>
					
					
				</div>
			</div>
		
			<div class="item">
				<a name='velocity'></a>
				<div class="well well-small name"><b>Field velocity : <a href="Modules_congo.point_Point.html">Point</a></b></div>
				<div class="description">
					<p></p>
					
					
				</div>
			</div>
		
			<div class="item">
				<a name='xlocked'></a>
				<div class="well well-small name"><b>Field xlocked : Bool</b></div>
				<div class="description">
					<p></p>
					
					
				</div>
			</div>
		
			<div class="item">
				<a name='ylocked'></a>
				<div class="well well-small name"><b>Field ylocked : Bool</b></div>
				<div class="description">
					<p></p>
					
					
				</div>
			</div>
		
	</div>
	<hr>




						
	<h2>Constructor Documentation</h2>
	<div class="scope-members-list">
		
			<div class="item">
				<a name='New'></a>
				<div class="well well-small name"><b>Method New ( w:Int, h:Int )</b></div>
				<div class="description">
					<p>	Creates a scrolllayer with specified size (in device points, ie autofit virtual coords).</p>
					
					
				</div>
			</div>
		
	</div>
	<hr>




						
	<h2>Method Documentation</h2>
	<div class="scope-members-list">
		
			<div class="item">
				<a name='AddSnapPoint'></a>
				<div class="well well-small name"><b>Method AddSnapPoint : Void ( pt:<a href="Modules_congo.point_Point.html">Point</a> )</b></div>
				<div class="description">
					<p>	Adds a 'snap' point. The layer will lock to these if moving slowly enough.</p>
					
					
				</div>
			</div>
		
			<div class="item">
				<a name='Update'></a>
				<div class="well well-small name"><b>Method Update : Void ( dT:Int )</b></div>
				<div class="description">
					<p></p>
					
					
				</div>
			</div>
		
	</div>
	<hr>




				
			</div>
		</div>
	</div>
</body>
</html>